<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>report_format</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Boost.Test">
<link rel="up" href="../rt_param_reference.html" title="Runtime parameters reference">
<link rel="prev" href="random.html" title="random">
<link rel="next" href="report_level.html" title="report_level">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_test.utf_reference.rt_param_reference.report_format"></a><a class="link" href="report_format.html" title="report_format"><code class="computeroutput"><span class="identifier">report_format</span></code></a>
</h4></div></div></div>
<p>
          Parameter <span class="emphasis"><em>report_format</em></span> allows to set the <span class="emphasis"><em>Unit
          Test Framework</em></span> report format to one of the formats supplied
          by the framework. To specify a custom report format use unit_test_report
          API.
        </p>
<p>
          The only acceptable values for this parameter are the names of the output
          formats. By default the framework uses human readable format (HRF) for
          results reporting. Alternatively you can specify XML as report format.
          This format is easier to process by testing automation tools.
        </p>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.report_format.h0"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.acceptable_values"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.acceptable_values">Acceptable
          values</a>
        </h5>
<p>
          <a class="link" href="../rt_param_reference.html#enum_param_value">Enumeration</a> names:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              <span class="bold"><strong>HRF</strong></span> (default)
            </li>
<li class="listitem">
              XML
            </li>
</ul></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.report_format.h1"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.command_line_syntax"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.command_line_syntax">Command
          line syntax</a>
        </h5>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
              <code class="computeroutput"><span class="special">--</span><span class="identifier">report_format</span><span class="special">=&lt;</span><span class="identifier">format</span><span class="special">&gt;</span></code>
            </li>
<li class="listitem">
              <code class="computeroutput"><span class="special">-</span><span class="identifier">m</span>
              <span class="special">&lt;</span><span class="identifier">format</span><span class="special">&gt;</span></code>
            </li>
</ul></div>
<h5>
<a name="boost_test.utf_reference.rt_param_reference.report_format.h2"></a>
          <span class="phrase"><a name="boost_test.utf_reference.rt_param_reference.report_format.environment_variable"></a></span><a class="link" href="report_format.html#boost_test.utf_reference.rt_param_reference.report_format.environment_variable">Environment
          variable</a>
        </h5>
<pre class="programlisting"><span class="identifier">BOOST_TEST_REPORT_FORMAT</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2001-2022 Boost.Test contributors<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="random.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../rt_param_reference.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="report_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
